/*
 * Copyright (c) 2010, Yawning <yawninglol at gmail.com>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *
 *   * Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *
 *   * Neither the name of the Mew Developers nor the
 *     names of its contributors may be used to endorse or promote products
 *     derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 * THE POSSIBILITY OF SUCH DAMAGE.
 */

package yawning.mew.pivot;

import java.io.File;

import org.apache.pivot.collections.Map;
import org.apache.pivot.wtk.Component;

import yawning.mew.character.Clazz;
import yawning.mew.character.TalentTree;

/**
 * Mew Pivot Model Interface.
 *
 * @author Yawning <yawninglol at gmail.com>
 */
public abstract class MewPivotModel {
	protected Component mTab;
	protected String mTabName;
	protected MewPivot mMewPivot;

	protected File mFile;

	public MewPivotModel(MewPivot mewPivot) {
		this.mMewPivot = mewPivot;
		this.mFile = null;
	}

	public String getTabName() {
		return mTabName;
	}

	public Component getTab() {
		return mTab;
	}

	public File getFile() {
		return mFile;
	}

	public void setFile(File file) {
		mFile = file;
	}

	/**
	 * Open handler.
	 * @param backingStore
	 */
	public abstract void onOpen(Map<String, Object> backingStore);

	/**
	 * Save handler.
	 * @param backingStore
	 */
	public abstract void onSave(Map<String, Object> backingStore);

	/**
	 * Close handler.
	 */
	public abstract void onClose();

	public abstract MewPivotTalentBase getTalentComponent();

	public abstract MewPivotGearBase getGearComponent();

	public abstract Clazz getExpectedClazz();

	public abstract TalentTree getExpectedTalentTree();
}
